GET api/agencies?agencyIds[0]={agencyIds[0]}&agencyIds[1]={agencyIds[1]}

Gets all the available agencies for the current tenant. Results will be filtered based on provided agency Ids.

Request Information

URI Parameters

Name	Description	Type	Additional information
agencyIds		Collection of integer	None.

Body Parameters

None.

Response Information

Resource Description

Returns the available agencies.

Collection of Agency

Name	Description	Type	Additional information
ID	The Agency ID	integer	None.
Name	The name of the Agency	string	None.
Description	A description of the Agency	string	None.
Address	The Agency location	Location	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "address": {
      "id": 1,
      "description": "sample string 1",
      "category": "sample string 2",
      "categoryId": "sample string 3",
      "name": "sample string 4",
      "latitude": 1.1,
      "longitude": 1.1,
      "streetNumber": "sample string 5",
      "onStreet": "sample string 6",
      "atStreet": "sample string 7",
      "city": "sample string 8",
      "state": "sample string 9",
      "postalCode": "sample string 10",
      "itemType": 0,
      "internalType": 0,
      "unit": "sample string 11",
      "comments": "sample string 12",
      "isGeocoded": true,
      "contact": {
        "id": 1,
        "referenceId": "sample string 2",
        "contactType": "sample string 3",
        "firstName": "sample string 4",
        "lastName": "sample string 5",
        "comments": "sample string 6",
        "details": [
          {
            "id": 1,
            "contactString": "sample string 2",
            "type": {
              "code": "sample string 1",
              "name": "sample string 2",
              "type": 0
            },
            "isPreferred": true
          },
          {
            "id": 1,
            "contactString": "sample string 2",
            "type": {
              "code": "sample string 1",
              "name": "sample string 2",
              "type": 0
            },
            "isPreferred": true
          }
        ]
      },
      "country": "sample string 14",
      "stopCode": "sample string 15",
      "procedureModifier": "sample string 16",
      "timeZoneId": "sample string 17"
    }
  },
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "address": {
      "id": 1,
      "description": "sample string 1",
      "category": "sample string 2",
      "categoryId": "sample string 3",
      "name": "sample string 4",
      "latitude": 1.1,
      "longitude": 1.1,
      "streetNumber": "sample string 5",
      "onStreet": "sample string 6",
      "atStreet": "sample string 7",
      "city": "sample string 8",
      "state": "sample string 9",
      "postalCode": "sample string 10",
      "itemType": 0,
      "internalType": 0,
      "unit": "sample string 11",
      "comments": "sample string 12",
      "isGeocoded": true,
      "contact": {
        "id": 1,
        "referenceId": "sample string 2",
        "contactType": "sample string 3",
        "firstName": "sample string 4",
        "lastName": "sample string 5",
        "comments": "sample string 6",
        "details": [
          {
            "id": 1,
            "contactString": "sample string 2",
            "type": {
              "code": "sample string 1",
              "name": "sample string 2",
              "type": 0
            },
            "isPreferred": true
          },
          {
            "id": 1,
            "contactString": "sample string 2",
            "type": {
              "code": "sample string 1",
              "name": "sample string 2",
              "type": 0
            },
            "isPreferred": true
          }
        ]
      },
      "country": "sample string 14",
      "stopCode": "sample string 15",
      "procedureModifier": "sample string 16",
      "timeZoneId": "sample string 17"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfAgency xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <Agency>
    <Address>
      <AtStreet>sample string 7</AtStreet>
      <Category>sample string 2</Category>
      <CategoryId>sample string 3</CategoryId>
      <City>sample string 8</City>
      <Comments>sample string 12</Comments>
      <Contact>
        <Comments>sample string 6</Comments>
        <ContactType>sample string 3</ContactType>
        <Details>
          <ContactDetail>
            <ContactString>sample string 2</ContactString>
            <ID>1</ID>
            <IsPreferred>true</IsPreferred>
            <Type>
              <Code>sample string 1</Code>
              <Name>sample string 2</Name>
              <Type>Phone</Type>
            </Type>
          </ContactDetail>
          <ContactDetail>
            <ContactString>sample string 2</ContactString>
            <ID>1</ID>
            <IsPreferred>true</IsPreferred>
            <Type>
              <Code>sample string 1</Code>
              <Name>sample string 2</Name>
              <Type>Phone</Type>
            </Type>
          </ContactDetail>
        </Details>
        <FirstName>sample string 4</FirstName>
        <ID>1</ID>
        <LastName>sample string 5</LastName>
        <ReferenceId>sample string 2</ReferenceId>
      </Contact>
      <Country>sample string 14</Country>
      <Description>sample string 1</Description>
      <ID>1</ID>
      <InternalType>Location</InternalType>
      <IsGeocoded>true</IsGeocoded>
      <ItemType>Location</ItemType>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <Name>sample string 4</Name>
      <OnStreet>sample string 6</OnStreet>
      <PostalCode>sample string 10</PostalCode>
      <ProcedureModifier>sample string 16</ProcedureModifier>
      <State>sample string 9</State>
      <StopCode>sample string 15</StopCode>
      <StreetNumber>sample string 5</StreetNumber>
      <TimeZoneId>sample string 17</TimeZoneId>
      <Unit>sample string 11</Unit>
    </Address>
    <Description>sample string 3</Description>
    <ID>1</ID>
    <Name>sample string 2</Name>
  </Agency>
  <Agency>
    <Address>
      <AtStreet>sample string 7</AtStreet>
      <Category>sample string 2</Category>
      <CategoryId>sample string 3</CategoryId>
      <City>sample string 8</City>
      <Comments>sample string 12</Comments>
      <Contact>
        <Comments>sample string 6</Comments>
        <ContactType>sample string 3</ContactType>
        <Details>
          <ContactDetail>
            <ContactString>sample string 2</ContactString>
            <ID>1</ID>
            <IsPreferred>true</IsPreferred>
            <Type>
              <Code>sample string 1</Code>
              <Name>sample string 2</Name>
              <Type>Phone</Type>
            </Type>
          </ContactDetail>
          <ContactDetail>
            <ContactString>sample string 2</ContactString>
            <ID>1</ID>
            <IsPreferred>true</IsPreferred>
            <Type>
              <Code>sample string 1</Code>
              <Name>sample string 2</Name>
              <Type>Phone</Type>
            </Type>
          </ContactDetail>
        </Details>
        <FirstName>sample string 4</FirstName>
        <ID>1</ID>
        <LastName>sample string 5</LastName>
        <ReferenceId>sample string 2</ReferenceId>
      </Contact>
      <Country>sample string 14</Country>
      <Description>sample string 1</Description>
      <ID>1</ID>
      <InternalType>Location</InternalType>
      <IsGeocoded>true</IsGeocoded>
      <ItemType>Location</ItemType>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <Name>sample string 4</Name>
      <OnStreet>sample string 6</OnStreet>
      <PostalCode>sample string 10</PostalCode>
      <ProcedureModifier>sample string 16</ProcedureModifier>
      <State>sample string 9</State>
      <StopCode>sample string 15</StopCode>
      <StreetNumber>sample string 5</StreetNumber>
      <TimeZoneId>sample string 17</TimeZoneId>
      <Unit>sample string 11</Unit>
    </Address>
    <Description>sample string 3</Description>
    <ID>1</ID>
    <Name>sample string 2</Name>
  </Agency>
</ArrayOfAgency>